home *** CD-ROM | disk | FTP | other *** search
/ HPAVC / HPAVC CD-ROM.iso / PWAEF22.ZIP / EFLAG.DOC < prev    next >
Text File  |  1995-05-11  |  9KB  |  173 lines
  1.  
  2. +-----------------------------------------------------------------------------+
  3. | Enhanced Flag v2.2                                                          |
  4. | Written by Drew [PWA]                                                       |
  5. | Docs Last Updated 05-10-95                                                  |
  6. +-----------------------------------------------------------------------------+
  7.  
  8.  
  9. +-----------------------------------------------------------------------------+
  10. | 0. Table of Contents                                                        |
  11. +-----------------------------------------------------------------------------+
  12.     1. Introduction
  13.     2. Packaging
  14.     3. Installation
  15.     4. Configuration
  16.     5. General Notes
  17.     6. Supporting PPE's
  18.     7. Last Words
  19.  
  20.  
  21. +-----------------------------------------------------------------------------+
  22. | 1. Introduction                                                             |
  23. +-----------------------------------------------------------------------------+
  24.     See HISTORY.DOC for all changes.  Otherwise...
  25.  
  26.     Enhanced Flag is a PPE replacement for the "More?" prompt during a file
  27. listing.  It gives you an easier to method of flagging files for downloading,
  28. viewing, nuking, et. al. by using a lightbar and hotkey driven interface, in-
  29. cluding all of the arrow keys.
  30.  
  31.     Additionally, through the usage of configuration files, EFLAG can spawn
  32. custom external commands (other PPE's) in addition to or replacing any or all
  33. of the built-in commands.
  34.  
  35.     This PPE was written in PPL 3.0 for PCBoard 15.2+ only.
  36.  
  37.  
  38. +-----------------------------------------------------------------------------+
  39. | 2. Packaging                                                                |
  40. +-----------------------------------------------------------------------------+
  41.     Your zip file should contain the following files:
  42.  
  43.         EFLAG    CFG   Main EFLAG configuration file
  44.         EFLAG    DOC   EFLAG Documentation (you are reading it now)
  45.         EFLAG    HLP   EFLAG help screen
  46.         EFLAG    PPE   The actual PPE
  47.         EXTERNAL ZIP   Sample front-end ppe's to use
  48.         HISTORY  DOC   History/revision document
  49.         INSTALL  BAT   Installation batch file
  50.         PROMPT1  CFG   Configuration file for Prompt #1
  51.         PROMPT2  CFG   Configuration file for Prompt #2
  52.         YESNO    CFG   Configuration file for yes/no prompt
  53.         OTHERDJP DOC   Other stuff I've written.
  54.         FILE_ID  DIZ   File (zip) description.
  55.         PWA      NFO   PWA info file.
  56.         TSP      NFO   My bbs ad.
  57.  
  58.     If any of these files are missing, be warned that you may have a copy
  59. that has been tampered with.  If you have any extra files, they are
  60. extraneous and unnecessary.
  61.  
  62.     Typically, my bbs ad may not be there, which is not a problem.  However,
  63. the idiots who contribute this to the fidonet backbone (usually originating
  64. from the Clipper Workshop BBS) edit the FILE_ID.DIZ, remove PWA.NFO and
  65. OTHERDJP.DOC, and insert their own bbs ad which is bigger than most ppe's.
  66. Just be aware, since who knows what other stupidities they may pull.
  67.  
  68.  
  69. +-----------------------------------------------------------------------------+
  70. | 3. Installation                                                             |
  71. +-----------------------------------------------------------------------------+
  72.     Simply unzip the original zip file into its own directory and run the
  73. INSTALL.BAT file.  It will automatically tell you the syntax needed to install
  74. EFLAG.  For manual installation, run MKPCBTXT to edit your PCBTEXT file, and
  75. have Prompt #549 point to this ppe.  Ie: !C:\PPE\EFLAG\EFLAG.PPE
  76.  
  77.     If you are upgrading from EFLAG v1.0, you must REINSTALL the entire thing
  78. because EFLAG v2.0 has been completely redone and everything is different.
  79.  
  80.  
  81. +-----------------------------------------------------------------------------+
  82. | 4. Configuration                                                            |
  83. +-----------------------------------------------------------------------------+
  84.     There are three configuration files, all of which are optional.  Default
  85. values will be used in the lack of presence of these configuration files, but
  86. the colours will most like clash with your boards colour scheme. :)  The
  87. configuration files are as follows:
  88.  
  89.         EFLAG.CFG   : Eflag behaviour-type options; only 4 lines long. :)
  90.         PROMPT1.CFG : Configure the look, feel, and commands for Prompt #1.
  91.         PROMPT2.CFG : Configure the look, feel, and commands for Prompt #2.
  92.  
  93.     All config files are well-documented inside and should be fairly straight
  94. forward.  None of them are heinously long or complex, unless you choose it to
  95. be. :)
  96.  
  97.     In v2.2, a new configuration file, "YESNO.CFG" is added.  This is used
  98. to ask the user is they are sure they want to display the file listing in
  99. nonstop mode.  This feature was added because some users may accidentally
  100. select nonstop mode and do not realize ctrl-k/x aborts the humongous file
  101. listing. :)  If you do not want this feature enabled, simply delete (or
  102. rename) this config file.
  103.  
  104.  
  105. +-----------------------------------------------------------------------------+
  106. | 5. General Notes                                                            |
  107. +-----------------------------------------------------------------------------+
  108.     After v1.0 of EFLAG, which was released back in August 1994, I made some
  109. minor changes/additions/modifications.  Some were minor "bug" fixes, which
  110. were mostly small details in packaging, and did not affect the actual usage of
  111. EFLAG.  A few new features were added as well to make EFLAG even more useful.
  112.  
  113.     However, since that time, PPL 3.0 and PCBoard 15.2 was released and the
  114. continuation of writing more sloppy code in PPL 2.0 seemed moot.  Hence, after
  115. an extremely busy few months dealing with many many things at once, EFLAG 2.0
  116. was completely rewritten in PPL 3.0 and reincarnated.
  117.  
  118.    If you would like your prompts, pathnames, et. al. hard-coded into the
  119. program for fastest execution speed possible (thus removing the need for all
  120. the config files), feel free to let me know.  I will need a copy of all the
  121. config files.  See below on how to contact me.
  122.  
  123.  
  124. +-----------------------------------------------------------------------------+
  125. | 6. Supporting PPE's                                                         |
  126. +-----------------------------------------------------------------------------+
  127.     EFLAG has been personally tested by me <g> to work with the following PPE's
  128. fully with no problem:
  129.  
  130.         o  PWA FileView v2.5
  131.         o  SCuM-NuKeR v1.0/1.1
  132.         o  BlackCat's File Viewer v1.0, v2.0, v2.1
  133.         o  BlackCat's Nuker v0.81b, v0.82b
  134.  
  135. Included is EXTERNAL.ZIP which includes some front-end ppe's for usage with
  136. EFLAG to allow EFLAG to execute some the above ppe's seamlessly.  Take a look
  137. inside there for examples, instructions, and details.  If you have a particu-
  138. lar PPE that you wish to interface with EFLAG, feel free to drop me a note if
  139. you need help.
  140.  
  141.  
  142. +-----------------------------------------------------------------------------+
  143. | 7. Last Words                                                               |
  144. +-----------------------------------------------------------------------------+
  145.     (Bitch-mode on.)
  146.  
  147.     I've had a flood of requests for a bunch of my source code.  Some because
  148. they just want to have it, others even going so much as to say something to
  149. the sense of, "With a name like Pirates With Attitudes, I'm obligated to check
  150. for backdoors before running the PPE on my system."
  151.  
  152.     I'm fed up with this.  I've never included a backdoor in any of my work
  153. and am not about to start.  My current policy for distribution of source code
  154. is that I'm only giving it to people who are going to make a significant
  155. amount of modifications to it (and I'll be the one who deems what is signi-
  156. ficant or not).  I know this sounds harsh, but hey, that's life.  At least I
  157. still make my source available.  If you need to learn how to program, then go
  158. buy a book, go to school, get the manual, or a combination thereof.  If that's
  159. not it and you just don't like the PPE, then don't use it.
  160.  
  161.     (Bitch-mode off.)
  162.  
  163.     Many thanks to those who have actually given me constructive criticism,
  164. suggestions, et al.  Most of you sent me internet email, so you know who
  165. you are. :)
  166.  
  167.     Otherwise, if you need to reach me for some reason, you can send internet
  168. email to "drew@xinet.com", or leave me a message on Attitude Net, or call my
  169. board: The Silicon Phalanx at 310-575-8567 and apply for access.
  170.  
  171. Peace,
  172. --Drew
  173.